Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs for ssl param in client #8403

Merged
merged 2 commits into from
May 8, 2024
Merged

Update docs for ssl param in client #8403

merged 2 commits into from
May 8, 2024

Conversation

aitor-gamarra
Copy link
Contributor

@aitor-gamarra aitor-gamarra commented May 8, 2024 •
edited
Loading

What do these changes do?

Improve the docs for the ssl params.

In the current docs, the following is written:

ssl –
SSL validation mode. None for default SSL check

However, None is deprecated since #8048 and the default is actually True as shown in the code:

ssl: Union[SSLContext, bool, Fingerprint] = True

Are there changes in behavior for the user?

Just docs.

Is it a substantial burden for the maintainers to support this?

No.

Related issue number

No.

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES/ folder

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label May 8, 2024
@Dreamsorcerer Dreamsorcerer added the backport-3.10 Trigger automatic backporting to the 3.10 release branch by Patchback robot label May 8, 2024
@codecov Codecov
Copy link

codecov bot commented May 8, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.64%. Comparing base (2eccb8b) to head (f1d133c).

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #8403   +/-   ##
=======================================
  Coverage   97.64%   97.64%           
=======================================
  Files         107      107           
  Lines       33067    33067           
  Branches     3885     3885           
=======================================
  Hits        32288    32288           
  Misses        562      562           
  Partials      217      217
Flag Coverage Δ
CI-GHA 97.55% <ø> (ø)
OS-Linux 97.22% <ø> (ø)
OS-Windows 95.64% <ø> (ø)
OS-macOS 96.79% <ø> (-0.09%) ⬇️
Py-3.10.11 97.03% <ø> (-0.01%) ⬇️
Py-3.10.14 96.98% <ø> (ø)
Py-3.11.9 97.20% <ø> (ø)
Py-3.12.3 97.30% <ø> (-0.03%) ⬇️
Py-3.8.10 95.41% <ø> (ø)
Py-3.8.18 96.67% <ø> (-0.21%) ⬇️
Py-3.9.13 95.46% <ø> (-1.56%) ⬇️
Py-3.9.19 96.97% <ø> (ø)
Py-pypy7.3.15 96.54% <ø> (+<0.01%) ⬆️
VM-macos 96.79% <ø> (-0.09%) ⬇️
VM-ubuntu 97.22% <ø> (ø)
VM-windows 95.64% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Dreamsorcerer Dreamsorcerer merged commit 06033c2 into aio-libs:master May 8, 2024
39 of 40 checks passed
@patchback Patchback
Copy link
Contributor

patchback bot commented May 8, 2024 •
edited
Loading

Backport to 3.10: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.10/06033c231c3ff28bd1a2046fe23029f4cacf1e44/pr-8403

Backported as #8404

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request May 8, 2024
@aitor-gamarra @patchback
Update docs for ssl param in client (#8403)
fa2f4af 
(cherry picked from commit 06033c2)
@patchback patchback bot mentioned this pull request May 8, 2024
Merged
5 tasks
Dreamsorcerer pushed a commit that referenced this pull request May 8, 2024
@patchback @aitor-gamarra
[PR #8403/06033c23 backport][3.10] Update docs for ssl param in client (
e839279 
#8404)

**This is a backport of PR #8403 as merged into master
(06033c2).**

Co-authored-by: Aitor Gamarra <60578201+aitor-gamarra@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@webknjaz webknjaz Awaiting requested review from webknjaz webknjaz is a code owner

@asvetlov asvetlov Awaiting requested review from asvetlov asvetlov is a code owner

Assignees
No one assigned
Labels
backport-3.10 Trigger automatic backporting to the 3.10 release branch by Patchback robot bot:chronographer:provided There is a change note present in this PR
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@aitor-gamarra @Dreamsorcerer